Fix rate limiter documentation for default burst value#2925
Merged
aldas merged 1 commit intolabstack:masterfrom Mar 29, 2026
Merged
Fix rate limiter documentation for default burst value#2925aldas merged 1 commit intolabstack:masterfrom
aldas merged 1 commit intolabstack:masterfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2925 +/- ##
=======================================
Coverage 93.01% 93.01%
=======================================
Files 43 43
Lines 4496 4498 +2
=======================================
+ Hits 4182 4184 +2
Misses 196 196
Partials 118 118 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The documentation for
NewRateLimiterMemoryStoreandNewRateLimiterMemoryStoreWithConfigstates that the default Burstvalue is the "rounded down" value of the rate. This was accurate when
the documentation was added in #2366, where the code used
int(config.Rate).However, #2852 changed the default burst calculation to use
math.Ceil,making it the rounded up value. The documentation was not updated to
reflect this change.